<!--
  ~ ***********************************************************************
  ~
  ~  Copyright (C) 2010 - 2015
  ~
  ~  [Component.java]
  ~  JACPFX Project (https://github.com/JacpFX/JacpFX/)
  ~  All rights reserved.
  ~
  ~  Licensed under the Apache License, Version 2.0 (the "License");
  ~  you may not use this file except in compliance with the License.
  ~  You may obtain a copy of the License at
  ~
  ~      http://www.apache.org/licenses/LICENSE-2.0
  ~
  ~  Unless required by applicable law or agreed to in writing,
  ~  software distributed under the License is distributed on an "AS IS"
  ~  BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
  ~  express or implied. See the License for the specific language
  ~  governing permissions and limitations under the License.
  ~
  ~
  ~ ***********************************************************************/
  -->

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (1.8.0-ea) on Wed Jan 15 11:02:14 CET 2014 -->
<title>Context</title>
<meta name="date" content="2014-01-15">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="Context";
        }
    }
    catch(err) {
    }
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Context.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/jacpfx/api/context/Context.html" target="_top">Frames</a></li>
<li><a href="Context.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.application.api.context</div>
<h2 title="Interface Context" class="title">Interface Context&lt;L,M&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>L</code> - defines the listener type</dd>
<dd><code>M</code> - defines the basic message type</dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Context&lt;L,M&gt;</span></pre>
<div class="block">Created with IntelliJ IDEA.
 User: Andy Moncsek
 Date: 27.06.13
 Time: 21:12
 The Context interface gives access to components basic meta data as well as listeners and other services.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../org/jacpfx/api/context/Context.html" title="type parameter in Context">L</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jacpfx/api/context/Context.html#getEventHandler-M-">getEventHandler</a></span>(<a href="../../../../org/jacpfx/api/context/Context.html" title="type parameter in Context">M</a>&nbsp;message)</code>
<div class="block">Returns an event handler that handles messages to caller component</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/jacpfx/api/context/Context.html" title="type parameter in Context">L</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jacpfx/api/context/Context.html#getEventHandler-java.lang.String-M-">getEventHandler</a></span>(java.lang.String&nbsp;targetId,
               <a href="../../../../org/jacpfx/api/context/Context.html" title="type parameter in Context">M</a>&nbsp;message)</code>
<div class="block">Returns an event handler that handles messages to target component</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jacpfx/api/context/Context.html#getId--">getId</a></span>()</code>
<div class="block">Returns the id of the component.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jacpfx/api/context/Context.html#getName--">getName</a></span>()</code>
<div class="block">Returns the name of a component.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jacpfx/api/context/Context.html#getParentId--">getParentId</a></span>()</code>
<div class="block">Returns the ID of parent component/perspective.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.util.ResourceBundle</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jacpfx/api/context/Context.html#getResourceBundle--">getResourceBundle</a></span>()</code>
<div class="block">Returns the components resource bundle.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jacpfx/api/context/Context.html#isActive--">isActive</a></span>()</code>
<div class="block">Get the default active status of component.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jacpfx/api/context/Context.html#send-M-">send</a></span>(<a href="../../../../org/jacpfx/api/context/Context.html" title="type parameter in Context">M</a>&nbsp;message)</code>
<div class="block">Send a message to caller component itself.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jacpfx/api/context/Context.html#send-java.lang.String-M-">send</a></span>(java.lang.String&nbsp;targetId,
    <a href="../../../../org/jacpfx/api/context/Context.html" title="type parameter in Context">M</a>&nbsp;message)</code>
<div class="block">Send a message to defined targetId.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jacpfx/api/context/Context.html#setActive-boolean-">setActive</a></span>(boolean&nbsp;active)</code>
<div class="block">Set default active state of component.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jacpfx/api/context/Context.html#setExecutionTarget-java.lang.String-">setExecutionTarget</a></span>(java.lang.String&nbsp;id)</code>
<div class="block">Defines the perspective in which the component should executed in.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jacpfx/api/context/Context.html#setReturnTarget-java.lang.String-">setReturnTarget</a></span>(java.lang.String&nbsp;componentTargetId)</code>
<div class="block">Set component targetId which is the target of a background components return
 value; the return value will be handled like an average message and will
 be delivered to targeted component.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jacpfx/api/context/Context.html#setTargetLayout-java.lang.String-">setTargetLayout</a></span>(java.lang.String&nbsp;targetLayout)</code>
<div class="block">Defines the target layoutId, where the UI component should appear in,the layout is registered in perspective and is a placeholder for the component.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="send-java.lang.Object-">
<!--   -->
</a><a name="send-M-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>send</h4>
<pre>void&nbsp;send(<a href="../../../../org/jacpfx/api/context/Context.html" title="type parameter in Context">M</a>&nbsp;message)</pre>
<div class="block">Send a message to caller component itself.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>message,</code> - The message object.</dd>
</dl>
</li>
</ul>
<a name="send-java.lang.String-java.lang.Object-">
<!--   -->
</a><a name="send-java.lang.String-M-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>send</h4>
<pre>void&nbsp;send(java.lang.String&nbsp;targetId,
          <a href="../../../../org/jacpfx/api/context/Context.html" title="type parameter in Context">M</a>&nbsp;message)</pre>
<div class="block">Send a message to defined targetId.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>targetId,</code> - The target id for the message.</dd>
<dd><code>message,</code> - The message object.</dd>
</dl>
</li>
</ul>
<a name="getEventHandler-java.lang.Object-">
<!--   -->
</a><a name="getEventHandler-M-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEventHandler</h4>
<pre><a href="../../../../org/jacpfx/api/context/Context.html" title="type parameter in Context">L</a>&nbsp;getEventHandler(<a href="../../../../org/jacpfx/api/context/Context.html" title="type parameter in Context">M</a>&nbsp;message)</pre>
<div class="block">Returns an event handler that handles messages to caller component</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>message,</code> - The message object.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an JavaFX event handler.</dd>
</dl>
</li>
</ul>
<a name="getEventHandler-java.lang.String-java.lang.Object-">
<!--   -->
</a><a name="getEventHandler-java.lang.String-M-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEventHandler</h4>
<pre><a href="../../../../org/jacpfx/api/context/Context.html" title="type parameter in Context">L</a>&nbsp;getEventHandler(java.lang.String&nbsp;targetId,
                  <a href="../../../../org/jacpfx/api/context/Context.html" title="type parameter in Context">M</a>&nbsp;message)</pre>
<div class="block">Returns an event handler that handles messages to target component</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>message</code> - ; the message to send to target.</dd>
<dd><code>targetId</code> - ; the targets component id.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an JavaFX event handler.</dd>
</dl>
</li>
</ul>
<a name="getId--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getId</h4>
<pre>java.lang.String&nbsp;getId()</pre>
<div class="block">Returns the id of the component.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the component id</dd>
</dl>
</li>
</ul>
<a name="getParentId--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParentId</h4>
<pre>java.lang.String&nbsp;getParentId()</pre>
<div class="block">Returns the ID of parent component/perspective.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a component id</dd>
</dl>
</li>
</ul>
<a name="getName--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>java.lang.String&nbsp;getName()</pre>
<div class="block">Returns the name of a component.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the component name</dd>
</dl>
</li>
</ul>
<a name="getResourceBundle--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResourceBundle</h4>
<pre>java.util.ResourceBundle&nbsp;getResourceBundle()</pre>
<div class="block">Returns the components resource bundle.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the defined resource bundle</dd>
</dl>
</li>
</ul>
<a name="isActive--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isActive</h4>
<pre>boolean&nbsp;isActive()</pre>
<div class="block">Get the default active status of component.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the active state of component</dd>
</dl>
</li>
</ul>
<a name="setActive-boolean-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setActive</h4>
<pre>void&nbsp;setActive(boolean&nbsp;active)</pre>
<div class="block">Set default active state of component.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>active</code> - ; the component active state.</dd>
</dl>
</li>
</ul>
<a name="setReturnTarget-java.lang.String-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReturnTarget</h4>
<pre>void&nbsp;setReturnTarget(java.lang.String&nbsp;componentTargetId)
              throws java.lang.IllegalStateException</pre>
<div class="block">Set component targetId which is the target of a background components return
 value; the return value will be handled like an average message and will
 be delivered to targeted component.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>componentTargetId</code> - ; represents a component id to return the value to</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code></dd>
</dl>
</li>
</ul>
<a name="setExecutionTarget-java.lang.String-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExecutionTarget</h4>
<pre>void&nbsp;setExecutionTarget(java.lang.String&nbsp;id)
                 throws java.lang.IllegalStateException</pre>
<div class="block">Defines the perspective in which the component should executed in.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>id,</code> - the id of the parent perspective where the component should be executed in.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code></dd>
</dl>
</li>
</ul>
<a name="setTargetLayout-java.lang.String-">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setTargetLayout</h4>
<pre>void&nbsp;setTargetLayout(java.lang.String&nbsp;targetLayout)
              throws java.lang.IllegalStateException</pre>
<div class="block">Defines the target layoutId, where the UI component should appear in,the layout is registered in perspective and is a placeholder for the component.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>targetLayout,</code> - a target layout label.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Context.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/jacpfx/api/context/Context.html" target="_top">Frames</a></li>
<li><a href="Context.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
